<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>Standard library module | Butano Docs</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <link rel="icon" href="favicon-dark.png" type="image/png" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <meta name="theme-color" content="#22272e" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
        <a href="https://github.com/GValiente/butano">Butano</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</a>
      </span>
      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
        <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
          <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
        </svg></a>
        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
      </div>
      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
        <div class="m-row">
          <ol class="m-col-t-6 m-col-m-none">
            <li><a href="pages.html">Pages</a></li>
            <li><a href="modules.html">Modules</a></li>
          </ol>
          <ol class="m-col-t-6 m-col-m-none" start="3">
            <li><a href="namespaces.html">Namespaces</a></li>
            <li><a href="annotated.html">Classes</a></li>
            <li><a href="files.html">Files</a></li>
            <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
              <use href="#m-doc-search-icon-path" />
            </svg></a></li>
          </ol>
        </div>
      </div>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          Standard library <span class="m-thin">module</span></h1>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#groups">Modules</a></li>
                <li><a href="#files">Files</a></li>
                <li><a href="#func-members">Functions</a></li>
              </ul>
            </li>
          </ul>
        </nav>
<p>Butano standard library replacement.</p><p>Main differences against C++&#x27;s standard library is the usage of asserts instead of exceptions and that it avoids heap usage when possible.</p>
        <section id="groups">
          <h2><a href="#groups">Modules</a></h2>
          <dl class="m-doc">
            <dt>module <a href="group__container.html" class="m-doc">Containers</a></dt>
            <dd></dd>
            <dt>module <a href="group__utility.html" class="m-doc">Utilities</a></dt>
            <dd></dd>
            <dt>module <a href="group__functional.html" class="m-doc">Functional</a></dt>
            <dd></dd>
          </dl>
        </section>
        <section id="files">
          <h2><a href="#files">Files</a></h2>
          <dl class="m-doc">
            <dt>file <a href="bn__algorithm_8h.html" class="m-doc">bn_algorithm.h</a></dt>
            <dd></dd>
            <dt>file <a href="bn__bit_8h.html" class="m-doc">bn_bit.h</a></dt>
            <dd></dd>
            <dt>file <a href="bn__compare_8h.html" class="m-doc">bn_compare.h</a></dt>
            <dd></dd>
            <dt>file <a href="bn__cstdlib_8h.html" class="m-doc">bn_cstdlib.h</a></dt>
            <dd></dd>
            <dt>file <a href="bn__cstring_8h.html" class="m-doc">bn_cstring.h</a></dt>
            <dd></dd>
            <dt>file <a href="bn__iterator_8h.html" class="m-doc">bn_iterator.h</a></dt>
            <dd></dd>
            <dt>file <a href="bn__limits_8h.html" class="m-doc">bn_limits.h</a></dt>
            <dd></dd>
            <dt>file <a href="bn__type__traits_8h.html" class="m-doc">bn_type_traits.h</a></dt>
            <dd></dd>
          </dl>
        </section>
        <section id="func-members">
          <h2><a href="#func-members">Functions</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#gaeab5c49160ec14817319a257377c6bd7" class="m-doc">malloc</a>(</span><span class="m-doc-wrap">int bytes) -&gt; void*</span>
            </dt>
            <dd>Allocates uninitialized storage in EWRAM.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#gaabf2d375c341349999bc60835e47674a" class="m-doc">calloc</a>(</span><span class="m-doc-wrap">int num,
              int bytes) -&gt; void*</span>
            </dt>
            <dd>Allocates storage in EWRAM for an array of num objects of bytes size and initializes all bytes in it to zero.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#gaa32bd5f6749f0253113b1c4aa7585dea" class="m-doc">realloc</a>(</span><span class="m-doc-wrap">void* ptr,
              int new_bytes) -&gt; void*</span>
            </dt>
            <dd>Reallocates the given storage in the EWRAM.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#ga6f8bf32a45558fc595672345f903ddce" class="m-doc">free</a>(</span><span class="m-doc-wrap">void* ptr)</span>
            </dt>
            <dd>Deallocates the storage previously allocated by <a href="#gaeab5c49160ec14817319a257377c6bd7" class="m-doc">bn::<wbr />malloc</a>, <a href="#gaabf2d375c341349999bc60835e47674a" class="m-doc">bn::<wbr />calloc</a> or <a href="#gaa32bd5f6749f0253113b1c4aa7585dea" class="m-doc">bn::<wbr />realloc</a>.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#ga83ace66ec8ad6ad00ab775e4797fefa0" class="m-doc">memcpy</a>(</span><span class="m-doc-wrap">void* destination,
              const void* source,
              int bytes)</span>
            </dt>
            <dd>Copies the given bytes from the object pointed to by source to the object pointed to by destination.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#ga742a0605c28751346769e117ba35d980" class="m-doc">memset</a>(</span><span class="m-doc-wrap">void* destination,
              uint8_t value,
              int bytes)</span>
            </dt>
            <dd>Copies the given value into each of the first given bytes of the object pointed to by destination.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#ga208f29094bdfb4c2537675723fdf58bd" class="m-doc">memclear</a>(</span><span class="m-doc-wrap">void* destination,
              int bytes)</span>
            </dt>
            <dd>Copies the value <code>0</code> into each of the first given bytes of the object pointed to by destination.</dd>
          </dl>
        </section>
        <section>
          <h2>Function documentation</h2>
          <section class="m-doc-details" id="gaeab5c49160ec14817319a257377c6bd7"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void* </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#gaeab5c49160ec14817319a257377c6bd7" class="m-doc-self">malloc</a>(</span><span class="m-doc-wrap">int bytes)</span></span>
              <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__cstdlib_8h.html">&lt;bn_cstdlib.h&gt;</a></div>
            </h3>
            <p>Allocates uninitialized storage in EWRAM.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">bytes</td>
                  <td>Bytes to allocate.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>On success, returns the pointer to the beginning of newly allocated memory. On failure, returns <code>nullptr</code>.</td>
                </tr>
              </tfoot>
            </table>
<p>To avoid a memory leak, the returned pointer must be deallocated with <a href="#ga6f8bf32a45558fc595672345f903ddce" class="m-doc">bn::<wbr />free</a>.</p>
          </div></section>
          <section class="m-doc-details" id="gaabf2d375c341349999bc60835e47674a"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void* </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#gaabf2d375c341349999bc60835e47674a" class="m-doc-self">calloc</a>(</span><span class="m-doc-wrap">int num,
              int bytes)</span></span>
              <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__cstdlib_8h.html">&lt;bn_cstdlib.h&gt;</a></div>
            </h3>
            <p>Allocates storage in EWRAM for an array of num objects of bytes size and initializes all bytes in it to zero.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">num</td>
                  <td>Number of objects.</td>
                </tr>
                <tr>
                  <td>bytes</td>
                  <td>Size in bytes of each object.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>On success, returns the pointer to the beginning of newly allocated memory. On failure, returns <code>nullptr</code>.</td>
                </tr>
              </tfoot>
            </table>
<p>To avoid a memory leak, the returned pointer must be deallocated with <a href="#ga6f8bf32a45558fc595672345f903ddce" class="m-doc">bn::<wbr />free</a>.</p>
          </div></section>
          <section class="m-doc-details" id="gaa32bd5f6749f0253113b1c4aa7585dea"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void* </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#gaa32bd5f6749f0253113b1c4aa7585dea" class="m-doc-self">realloc</a>(</span><span class="m-doc-wrap">void* ptr,
              int new_bytes)</span></span>
              <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__cstdlib_8h.html">&lt;bn_cstdlib.h&gt;</a></div>
            </h3>
            <p>Reallocates the given storage in the EWRAM.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">ptr</td>
                  <td>Pointer to the storage to reallocate.</td>
                </tr>
                <tr>
                  <td>new_bytes</td>
                  <td>New size in bytes of the reallocated storage.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>On success, returns the pointer to the beginning of newly allocated storage. On failure, returns <code>nullptr</code>.</td>
                </tr>
              </tfoot>
            </table>
<p>If ptr was not previously allocated by <a href="#gaeab5c49160ec14817319a257377c6bd7" class="m-doc">bn::<wbr />malloc</a>, <a href="#gaabf2d375c341349999bc60835e47674a" class="m-doc">bn::<wbr />calloc</a> or <a href="#gaa32bd5f6749f0253113b1c4aa7585dea" class="m-doc">bn::<wbr />realloc</a>, the behavior is undefined.</p><p>On success, the original pointer ptr is invalidated and any access to it is undefined behavior (even if reallocation was in-place).</p><p>To avoid a memory leak, the returned pointer must be deallocated with <a href="#ga6f8bf32a45558fc595672345f903ddce" class="m-doc">bn::<wbr />free</a>.</p>
          </div></section>
          <section class="m-doc-details" id="ga6f8bf32a45558fc595672345f903ddce"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ga6f8bf32a45558fc595672345f903ddce" class="m-doc-self">free</a>(</span><span class="m-doc-wrap">void* ptr)</span></span>
              <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__cstdlib_8h.html">&lt;bn_cstdlib.h&gt;</a></div>
            </h3>
            <p>Deallocates the storage previously allocated by <a href="#gaeab5c49160ec14817319a257377c6bd7" class="m-doc">bn::<wbr />malloc</a>, <a href="#gaabf2d375c341349999bc60835e47674a" class="m-doc">bn::<wbr />calloc</a> or <a href="#gaa32bd5f6749f0253113b1c4aa7585dea" class="m-doc">bn::<wbr />realloc</a>.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">ptr</td>
                  <td>Pointer to the storage to deallocate. It is invalidated and any access to it is undefined behavior.</td>
                </tr>
              </tbody>
            </table>
<p>If ptr is <code>nullptr</code>, the function does nothing.</p><p>If ptr was not previously allocated by <a href="#gaeab5c49160ec14817319a257377c6bd7" class="m-doc">bn::<wbr />malloc</a>, <a href="#gaabf2d375c341349999bc60835e47674a" class="m-doc">bn::<wbr />calloc</a> or <a href="#gaa32bd5f6749f0253113b1c4aa7585dea" class="m-doc">bn::<wbr />realloc</a>, the behavior is undefined.</p>
          </div></section>
          <section class="m-doc-details" id="ga83ace66ec8ad6ad00ab775e4797fefa0"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ga83ace66ec8ad6ad00ab775e4797fefa0" class="m-doc-self">memcpy</a>(</span><span class="m-doc-wrap">void* destination,
              const void* source,
              int bytes)</span></span>
              <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__cstring_8h.html">&lt;bn_cstring.h&gt;</a></div>
            </h3>
            <p>Copies the given bytes from the object pointed to by source to the object pointed to by destination.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">destination</td>
                  <td>Pointer to the memory location to copy to.</td>
                </tr>
                <tr>
                  <td>source</td>
                  <td>Pointer to the memory location to copy from.</td>
                </tr>
                <tr>
                  <td>bytes</td>
                  <td>Number of bytes to copy.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="ga742a0605c28751346769e117ba35d980"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ga742a0605c28751346769e117ba35d980" class="m-doc-self">memset</a>(</span><span class="m-doc-wrap">void* destination,
              uint8_t value,
              int bytes)</span></span>
              <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__cstring_8h.html">&lt;bn_cstring.h&gt;</a></div>
            </h3>
            <p>Copies the given value into each of the first given bytes of the object pointed to by destination.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">destination</td>
                  <td>Pointer to the object to fill.</td>
                </tr>
                <tr>
                  <td>value</td>
                  <td>Fill byte.</td>
                </tr>
                <tr>
                  <td>bytes</td>
                  <td>Number of bytes to fill.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="ga208f29094bdfb4c2537675723fdf58bd"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ga208f29094bdfb4c2537675723fdf58bd" class="m-doc-self">memclear</a>(</span><span class="m-doc-wrap">void* destination,
              int bytes)</span></span>
              <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__cstring_8h.html">&lt;bn_cstring.h&gt;</a></div>
            </h3>
            <p>Copies the value <code>0</code> into each of the first given bytes of the object pointed to by destination.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">destination</td>
                  <td>Pointer to the object to clear.</td>
                </tr>
                <tr>
                  <td>bytes</td>
                  <td>Number of bytes to clear.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
<div class="m-doc-search" id="search">
  <a href="#!" onclick="return hideSearch()"></a>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-m-8 m-push-m-2">
        <div class="m-doc-search-header m-text m-small">
          <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
          <div id="search-symbolcount">&hellip;</div>
        </div>
        <div class="m-doc-search-content">
          <form>
            <input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
          </form>
          <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
          <div id="search-help" class="m-text m-dim m-text-center">
            <p class="m-noindent">Search for symbols, directories, files, pages or
            modules. You can omit any prefix from the symbol or file path; adding a
            <code>:</code> or <code>/</code> suffix lists all members of given symbol or
            directory.</p>
            <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span>
            / <span class="m-label m-dim">&uarr;</span> to navigate through the list,
            <span class="m-label m-dim">Enter</span> to go.
            <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
            copy a link to the result using <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">M</span> produces a Markdown link.</p>
          </div>
          <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
          <ul id="search-results"></ul>
        </div>
      </div>
    </div>
  </div>
</div>
<script src="search-v2.js"></script>
<script src="searchdata-v2.js" async="async"></script>
<footer><nav>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <p>Butano Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.14.0 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
      </div>
    </div>
  </div>
</nav></footer>
</body>
</html>
